Skip to content

[FC-0099] feat: add API function to return scopes IDs for user-role#117

Merged
mariajgrimaldi merged 2 commits intomainfrom
MJG/return-scopes-for-role
Oct 27, 2025
Merged

[FC-0099] feat: add API function to return scopes IDs for user-role#117
mariajgrimaldi merged 2 commits intomainfrom
MJG/return-scopes-for-role

Conversation

@mariajgrimaldi
Copy link
Copy Markdown
Member

@mariajgrimaldi mariajgrimaldi commented Oct 27, 2025 •
edited
Loading

Description

This PR adds a new API function to return all scopes assigned to a user-role assignment, which can later be used to filter objects based on what the user has access to. These specificities (queryset filtering) should be handled by the consumer service to keep the library decoupled enough.

Merge checklist:
Check off if complete or not applicable:

  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Oct 27, 2025
@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented Oct 27, 2025

Thanks for the pull request, @mariajgrimaldi!

This repository is currently maintained by @openedx/committers-openedx-authz.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Oct 27, 2025
@mariajgrimaldi
Copy link
Copy Markdown
Member Author

mariajgrimaldi commented Oct 27, 2025

@MaferMazu: FYI, this is for the get_libraries_for_user when searching in the library views and whenever we'd need to filter the content libraries queryset based on the user's role.

@mariajgrimaldi mariajgrimaldi moved this to Ready for review in RBAC AuthZ Board Oct 27, 2025
@mariajgrimaldi mariajgrimaldi merged commit dff3863 into main Oct 27, 2025
13 of 14 checks passed
@mariajgrimaldi mariajgrimaldi deleted the MJG/return-scopes-for-role branch October 27, 2025 14:17
@github-project-automation github-project-automation Bot moved this from Ready for review to Done in RBAC AuthZ Board Oct 27, 2025
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions Oct 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bmtcril bmtcril bmtcril approved these changes

@BryanttV BryanttV Awaiting requested review from BryanttV

@MaferMazu MaferMazu Awaiting requested review from MaferMazu

@rodmgwgu rodmgwgu Awaiting requested review from rodmgwgu

Assignees

No one assigned

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Contributions
Archived in project
RBAC AuthZ Board
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@mariajgrimaldi @openedx-webhooks @bmtcril